/*
 * Copyright (C) 2009 Rob Cash
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
 * DefaultStateTransition.java
 * 
 * Created on Jan 1, 2009 at 4:22:46 PM
 */

package org.robcash.commons.util;

/**
 * @param <T> Type of value contained by machine state
 * @author Rob
 */
public class DefaultStateTransition<T> implements StateTransition<T> {

    /**
     * Name
     */
    private String name;
    
    /**
     * Origin state
     */
    private State<T> origin;
    
    /**
     * Destination state
     */
    private State<T> destination;
    
    /**
     * Create a new state transition with the given <tt>name</tt>
     * @param name Name of state transition
     * @param origin Origin state
     * @param destination Destination state
     */
    public DefaultStateTransition(String name, State<T> origin, State<T> destination) {
        this.name = name;
        this.origin = origin;
        this.destination = destination;
    }

    /**
     * Get the name of the transition
     * @return Name of the transition
     */
    public String getName() {
        return name;
    }

    /**
     * Get the origin state
     * @return Origin state
     */
    public State<T> getOrigin() {
        return origin;
    }

    /**
     * Get the destination state
     * @return Destination state
     */
    public State<T> getDestination() {
        return destination;
    }

    /**
     * Indicates if the transition is a one-way (directed) or two-way
     * (bidirectional). In this implementation, the transition is always
     * one-way, so this method will always return false.
     * @return <tt>false</tt> if the transition is one-way; <tt>true</tt> if the
     * transition is two-way
     */
    public boolean isTwoWay() {
        return false;
    }

}
